package com.easystudy.conf;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * @文件名称: Swagger2Config.java
 * @功能描述: swagger文档配置
 * @版权信息: lixx2048@163.com
 * @技术交流: 961179337(QQ群)
 * @编写作者: 东为信息
 * @开发日期: 2023年11月14日
 * @历史版本: V1.0 
 * @备注信息: 
 */
@Configuration
@EnableSwagger2
public class Swagger2Config {
	
    @Bean
    // 创建API基本信息
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                // 扫描该包下的所有需要在Swagger中展示的API，@ApiIgnore注解标注的除外
                .apis(RequestHandlerSelectors.basePackage("com.easystudy.controller"))
                .paths(PathSelectors.any())
                .build()
                // 解决swagger,Long被解析为Integer,改为string
                .directModelSubstitute(Long.class, String.class)
                .directModelSubstitute(long.class, String.class);
    }
 
    // 创建API的基本信息，这些信息会在Swagger UI中进行显示
    @SuppressWarnings("deprecation")
	private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
        		// API 标题
                .title("视频盒子接口文档")
                // API描述
                .description("视频盒子相关接口") 
                // 联系人
                .contact("com.easystudy")
                // 版本号
                .version("1.0.0.1")									
                .build();
    }
}
